Institutions

>>>

GET /api/admin/v1/institutions/:id
Show logo

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  "id": 1,
  "institution_name": "logo",
  "logo_for_display": "5ahtzgfeoe6gvxfl00q174bx1w9y",
  "is_college": false
}

Params

Param name Description
id
required

Validations:

  • Must be a Integer
>>>

POST /api/admin/v1/institutions
Create logo

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  "id": 1,
  "institution_name": "logo",
  "logo_for_display": "5ahtzgfeoe6gvxfl00q174bx1w9y",
  "is_college": false
}

Params

Param name Description
institution
required

Validations:

  • Must be a Hash
institution[institution_name]
required

Validations:

  • Must be a String
institution[is_college]
required

Validations:

  • Must be one of: true, false, 1, 0.
institution[s3_key]
required

Validations:

  • Must be a String
>>>

PUT /api/admin/v1/institutions/:id
Update logo

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  "id": 1,
  "institution_name": "logo",
  "logo_for_display": "5ahtzgfeoe6gvxfl00q174bx1w9y",
  "is_college": false
}

Params

Param name Description
id
required

Validations:

  • Must be a Integer
institution
required

Validations:

  • Must be a Hash
institution[institution_name]
required

Validations:

  • Must be a String
institution[is_college]
required

Validations:

  • Must be one of: true, false, 1, 0.
institution[s3_key]
required

Validations:

  • Must be a String
>>>

DELETE /api/admin/v1/institutions/:id
Update logo

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  "success": true
}

Params

Param name Description
id
required

Validations:

  • Must be a Integer